<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Cache</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Cache</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
                <p class="implements">
            Implements interfaces:
            <ul>
                <li><a href="../Disperse/Cacheable.html">Cacheable</a></li>            </ul>
        </p>
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Wraps the major functionality of the Memcache class provided by the pecl_memcache extension.  An  instance of this class should be retrieved using CacheFactory, which maintains a static reference  throughout the request.</p>
		<p class="notes">
			Located in <a class="field" href="_php---cache---Cache.php.html">/php/cache/Cache.php</a> (line <span class="field"><a href="../__filesource/fsource_Disperse__phpcacheCache.php.html#a40">40</a></span>)
		</p>
		
				
		<pre><a href="../Disperse/CacheObject.html">CacheObject</a>
   |
   --Cache</pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-vars">Vars</a>
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Disperse/PersistedCache.html">PersistedCache</a></td>
					<td>
											Extends Cache and provides a persistent storage mechanism for cached data through the use of  Datasource and its accompanying objects.
										</td>
				</tr>
							</table>
		</div>
	</div>



	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																		<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																				
												<div class="method-definition">
											<span class="method-result">Cache</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#__destruct" title="details" class="method-name">__destruct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#delete" title="details" class="method-name">delete</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$table</span> = <span class="var-default">'data'</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$expiration</span> = <span class="var-default">0</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#expire" title="details" class="method-name">expire</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$table</span> = <span class="var-default">'data'</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#flush" title="details" class="method-name">flush</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#get" title="details" class="method-name">&amp;get</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$table</span> = <span class="var-default">'data'</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#isConnected" title="details" class="method-name">isConnected</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set" title="details" class="method-name">set</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">&$value</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$table</span> = <span class="var-default">'data'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$compress</span> = <span class="var-default">CACHE_COMPRESSION</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$expire</span> = <span class="var-default">CACHE_EXPIRATION</span>])
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../Disperse/CacheObject.html">CacheObject</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../Disperse/CacheObject.html#var$connection">CacheObject::$connection</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Disperse/CacheObject.html#var$isConnected">CacheObject::$isConnected</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-vars">Vars</a>
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpcacheCache.php.html#a45">45</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Class constructor</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Cache</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Disperse/PersistedCache.html#method__construct">PersistedCache::__construct()</a>
								: Class constructor
							</li>
				</ul>
	</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Destructor __destruct</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpcacheCache.php.html#a65">65</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Class destructor</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			__destruct
		</span>
				()
			</div>
	
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Disperse/PersistedCache.html#method__destruct">PersistedCache::__destruct()</a>
								: Class destructor
							</li>
				</ul>
	</div>
<a name="methoddelete" id="delete"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">delete</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpcacheCache.php.html#a79">79</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deletes the specified element from the cache.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			delete
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$table</span> = <span class="var-default">'data'</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$expiration</span> = <span class="var-default">0</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$key</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$table</span><span class="var-description">: = 'data'</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$expiration</span><span class="var-description">: = 0</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Disperse/CacheObject.html#methoddelete">CacheObject::delete()</a></dt>
						<dd>Deletes the specified element from the cache.</dd>
					</dl>
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Disperse/Cacheable.html#methoddelete">Cacheable::delete()</a></dt>
						<dd>Deletes the specified element from the cache.</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Disperse/PersistedCache.html#methoddelete">PersistedCache::delete()</a>
								: Deletes the specified element from the cache.
							</li>
				</ul>
	</div>
<a name="methodexpire" id="expire"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">expire</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpcacheCache.php.html#a90">90</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deletes items from the cache if they are due to expire.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			expire
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$table</span> = <span class="var-default">'data'</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$table</span><span class="var-description">: = 'data'</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Disperse/CacheObject.html#methodexpire">CacheObject::expire()</a></dt>
						<dd>Deletes items from the cache if they are due to expire.</dd>
					</dl>
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Disperse/Cacheable.html#methodexpire">Cacheable::expire()</a></dt>
						<dd>Deletes items from the cache if they are due to expire.</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Disperse/PersistedCache.html#methodexpire">PersistedCache::expire()</a>
								: Deletes items from the cache if they are due to expire.
							</li>
				</ul>
	</div>
<a name="methodflush" id="flush"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">flush</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpcacheCache.php.html#a95">95</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Flushes the entire cache.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			flush
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Disperse/CacheObject.html#methodflush">CacheObject::flush()</a></dt>
						<dd>Flushes the entire cache.</dd>
					</dl>
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Disperse/Cacheable.html#methodflush">Cacheable::flush()</a></dt>
						<dd>Flushes the entire cache.</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Disperse/PersistedCache.html#methodflush">PersistedCache::flush()</a>
								: Flushes the entire cache.
							</li>
				</ul>
	</div>
<a name="methodget" id="get"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpcacheCache.php.html#a108">108</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieves the specified element from the cache, or null if the element does not exist.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			&amp;get
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$table</span> = <span class="var-default">'data'</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$key</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$table</span><span class="var-description">: = 'data'</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Disperse/CacheObject.html#methodget">CacheObject::get()</a></dt>
						<dd>Retrieves the specified element from the cache, or null if the element does not exist.</dd>
					</dl>
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Disperse/Cacheable.html#methodget">Cacheable::get()</a></dt>
						<dd>Retrieves the specified element from the cache, or null if the element does not exist.</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Disperse/PersistedCache.html#methodget">PersistedCache::get()</a>
								: Retrieves the specified element from the cache, or null if the element does not exist.
							</li>
				</ul>
	</div>
<a name="methodisConnected" id="isConnected"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isConnected</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpcacheCache.php.html#a121">121</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns true if the cache is connected, false otherwise.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			isConnected
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Disperse/CacheObject.html#methodisConnected">CacheObject::isConnected()</a></dt>
						<dd>Returns true if the cache is connected, false otherwise.</dd>
					</dl>
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Disperse/Cacheable.html#methodisConnected">Cacheable::isConnected()</a></dt>
						<dd>Returns true if the cache is connected, false otherwise.</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Disperse/PersistedCache.html#methodisConnected">PersistedCache::isConnected()</a>
								: Returns true if the cache is connected, false otherwise.
							</li>
				</ul>
	</div>
<a name="methodset" id="set"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">set</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpcacheCache.php.html#a134">134</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Inserts/updates the specified element in the cache.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">&$value</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$table</span> = <span class="var-default">'data'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$compress</span> = <span class="var-default">CACHE_COMPRESSION</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$expire</span> = <span class="var-default">CACHE_EXPIRATION</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$key</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">&$value</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$table</span><span class="var-description">: = 'data'</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$compress</span><span class="var-description">: = CACHE_COMPRESSION</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$expire</span><span class="var-description">: = CACHE_EXPIRATION</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Disperse/CacheObject.html#methodset">CacheObject::set()</a></dt>
						<dd>Inserts/updates the specified element in the cache.</dd>
					</dl>
				<hr class="separator" />
		<div class="notes">Implementation of:</div>
			<dl>
			<dt><a href="../Disperse/Cacheable.html#methodset">Cacheable::set()</a></dt>
						<dd>Inserts/updates the specified element in the cache.</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Disperse/PersistedCache.html#methodset">PersistedCache::set()</a>
								: Inserts/updates the specified element in the cache.
							</li>
				</ul>
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../Disperse/CacheObject.html">CacheObject</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../Disperse/CacheObject.html#methoddelete">CacheObject::delete()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheObject.html#methodexpire">CacheObject::expire()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheObject.html#methodflush">CacheObject::flush()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheObject.html#methodget">CacheObject::get()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheObject.html#methodisConnected">CacheObject::isConnected()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheObject.html#methodset">CacheObject::set()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sat, 06 Mar 2010 15:50:38 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>